home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIGlobalHistory2.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.5 KB  |  93 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the Mozilla gecko engine.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Benjamin Smedberg <bsmedberg@covad.net>.
  19.  * Portions created by the Initial Developer are Copyright (C) 2004
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. /**
  39.  * Provides information about global history to gecko. 
  40.  *
  41.  * @note  This interface replaces and deprecates nsIGlobalHistory.
  42.  * @status UNDER_REVIEW
  43.  */
  44.  
  45. #include "nsISupports.idl"
  46. interface nsIURI;
  47.  
  48. %{ C++
  49.  
  50. // nsIObserver topic to fire when you add new visited URIs to the history;
  51. // the nsIURI is the subject
  52. #define NS_LINK_VISITED_EVENT_TOPIC "link-visited"
  53.  
  54. %}
  55.  
  56. [scriptable, uuid(cf777d42-1270-4b34-be7b-2931c93feda5)]
  57. interface nsIGlobalHistory2 : nsISupports
  58. {
  59.     /**
  60.      * Add a URI to global history
  61.      *
  62.      * @param aURI      the URI of the page
  63.      * @param aRedirect whether the URI was redirected to another location;
  64.      *                  this is 'true' for the original URI which is
  65.      *                  redirected.
  66.      * @param aToplevel whether the URI is loaded in a top-level window
  67.      * @param aReferrer the URI of the referring page
  68.      *
  69.      * @note  Docshell will not filter out URI schemes like chrome: data:
  70.      *        about: and view-source:.  Embedders should consider filtering out
  71.      *        these schemes and others, e.g. mailbox: for the main URI and the
  72.      *        referrer.
  73.      */
  74.     void addURI(in nsIURI aURI, in boolean aRedirect, in boolean aToplevel, in nsIURI aReferrer);
  75.  
  76.     /**
  77.      * Checks to see whether the given URI is in history.
  78.      *
  79.      * @param aURI the uri to the page
  80.      * @return true if a URI has been visited
  81.      */
  82.     boolean isVisited(in nsIURI aURI);
  83.  
  84.     /**
  85.      * Set the page title for the given uri. URIs that are not already in
  86.      * global history will not be added.
  87.      *
  88.      * @param aURI    the URI for which to set to the title
  89.      * @param aTitle  the page title
  90.      */
  91.     void setPageTitle(in nsIURI aURI, in AString aTitle);
  92. };
  93.